gridpack::mapper::GenMatrixMap< _network > Class Template Reference

#include <gen_matrix_map.hpp>

Collaboration diagram for gridpack::mapper::GenMatrixMap< _network >:

[legend]

List of all members.

Public Member Functions
	GenMatrixMap (boost::shared_ptr< _network > network)
	~GenMatrixMap ()
boost::shared_ptr < gridpack::math::Matrix >	mapToMatrix (void)
gridpack::math::Matrix *	intMapToMatrix (void)
void	mapToMatrix (gridpack::math::Matrix &matrix)
void	mapToMatrix (boost::shared_ptr< gridpack::math::Matrix > &matrix)
void	overwriteMatrix (gridpack::math::Matrix &matrix)
void	overwriteMatrix (boost::shared_ptr< gridpack::math::Matrix > &matrix)
void	incrementMatrix (gridpack::math::Matrix &matrix)
void	incrementMatrix (boost::shared_ptr< gridpack::math::Matrix > &matrix)

template<class _network>
class gridpack::mapper::GenMatrixMap< _network >

---

Constructor & Destructor Documentation

template<class _network >

gridpack::mapper::GenMatrixMap< _network >::GenMatrixMap

(

boost::shared_ptr< _network >

network

)

Initialize mapper for the given network and the current mode. Create global arrays that contain offsets that will be used to create matrix from the network component objects

Parameters:

network

network that will generate matrix

template<class _network >

gridpack::mapper::GenMatrixMap< _network >::~GenMatrixMap

(

)

---

Member Function Documentation

template<class _network >

void gridpack::mapper::GenMatrixMap< _network >::incrementMatrix

(

boost::shared_ptr< gridpack::math::Matrix > &

matrix

)

Increment elements of existing matrix. This can be used to increment selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::GenMatrixMap< _network >::incrementMatrix().

template<class _network >

void gridpack::mapper::GenMatrixMap< _network >::incrementMatrix

(

gridpack::math::Matrix &

matrix

)

Increment elements of existing matrix. This can be used to increment selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::math::BaseMatrixInterface< T, I >::ready().

template<class _network >

gridpack::math::Matrix* gridpack::mapper::GenMatrixMap< _network >::intMapToMatrix

(

void

)

Generate matrix from current component state on network and return a conventional pointer to it. Used for Fortran interface

Returns:

return a pointer to new matrix

References gridpack::math::BaseMatrixInterface< T, I >::ready().

template<class _network >

void gridpack::mapper::GenMatrixMap< _network >::mapToMatrix

(

boost::shared_ptr< gridpack::math::Matrix > &

matrix

)

Reset existing matrix from current component state on network

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::GenMatrixMap< _network >::mapToMatrix().

template<class _network >

void gridpack::mapper::GenMatrixMap< _network >::mapToMatrix

(

gridpack::math::Matrix &

matrix

)

Reset existing matrix from current component state on network

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::math::BaseMatrixInterface< T, I >::ready(), and gridpack::math::BaseMatrixInterface< T, I >::zero().

template<class _network >

boost::shared_ptr<gridpack::math::Matrix> gridpack::mapper::GenMatrixMap< _network >::mapToMatrix

(

void

)

Generate matrix from current component state on network

Returns:

return a pointer to new matrix

template<class _network >

void gridpack::mapper::GenMatrixMap< _network >::overwriteMatrix

(

boost::shared_ptr< gridpack::math::Matrix > &

matrix

)

Overwrite elements of existing matrix. This can be used to overwrite selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::mapper::GenMatrixMap< _network >::overwriteMatrix().

template<class _network >

void gridpack::mapper::GenMatrixMap< _network >::overwriteMatrix

(

gridpack::math::Matrix &

matrix

)

Overwrite elements of existing matrix. This can be used to overwrite selected elements of a matrix

Parameters:

matrix

existing matrix (should be generated from same mapper)

References gridpack::math::BaseMatrixInterface< T, I >::ready().

---

The documentation for this class was generated from the following file:

• gen_matrix_map.hpp